<html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Hammerspoon docs: PasswordGenerator</title>
    <style type="text/css">
      a { text-decoration: none; }
      a:hover { text-decoration: underline; }
      th { background-color: #DDDDDD; vertical-align: top; padding: 3px; }
      td { width: 100%; background-color: #EEEEEE; vertical-align: top; padding: 3px; }
      table { width: 100% ; border: 1px solid #0; text-align: left; }
      section > table table td { width: 0; }
    </style>
    <link rel="stylesheet" href="docs.css" type="text/css" media="screen" />
  </head>
  <body>
    <header>
      <h1><a href="./index.html">docs</a> &raquo; PasswordGenerator</h1>
      <p>Generate a password and copy to the clipboard.</p>
<p>Download: <a href="https://github.com/Hammerspoon/Spoons/raw/master/Spoons/PasswordGenerator.spoon.zip">https://github.com/Hammerspoon/Spoons/raw/master/Spoons/PasswordGenerator.spoon.zip</a></p>

      </header>
      <h3>API Overview</h3>
      <ul>
        <li>Variables - Configurable values</li>
          <ul>
            <li><a href="#password_generator_function">password_generator_function</a></li>
            <li><a href="#password_length">password_length</a></li>
            <li><a href="#password_style">password_style</a></li>
            <li><a href="#word_count">word_count</a></li>
            <li><a href="#word_leet">word_leet</a></li>
            <li><a href="#word_separators">word_separators</a></li>
            <li><a href="#word_uppercase">word_uppercase</a></li>
          </ul>
        <li>Methods - API calls which can only be made on an object returned by a constructor</li>
          <ul>
            <li><a href="#bindHotkeys">bindHotkeys</a></li>
            <li><a href="#copyPassword">copyPassword</a></li>
            <li><a href="#pastePassword">pastePassword</a></li>
          </ul>
      </ul>
      <h3>API Documentation</h3>
        <h4 class="documentation-section">Variables</h4>
          <section id="password_generator_function">
            <a name="//apple_ref/cpp/Variable/password_generator_function" class="dashAnchor"></a>
            <h5><a href="#password_generator_function">password_generator_function</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.password_generator_function</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Explicit function used to generate passwords, if nil style is used instead.</p>
</td>
              </tr>
            </table>
          </section>
          <section id="password_length">
            <a name="//apple_ref/cpp/Variable/password_length" class="dashAnchor"></a>
            <h5><a href="#password_length">password_length</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.password_length</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Length of generated passwords. Is ignored by style xkcd.</p>
</td>
              </tr>
            </table>
          </section>
          <section id="password_style">
            <a name="//apple_ref/cpp/Variable/password_style" class="dashAnchor"></a>
            <h5><a href="#password_style">password_style</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.password_style</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Style for the generated password.</p>
</td>
              </tr>
            </table>
          </section>
          <section id="word_count">
            <a name="//apple_ref/cpp/Variable/word_count" class="dashAnchor"></a>
            <h5><a href="#word_count">word_count</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.word_count</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Number of words in generated passwords. Used by xkcd.</p>
</td>
              </tr>
            </table>
          </section>
          <section id="word_leet">
            <a name="//apple_ref/cpp/Variable/word_leet" class="dashAnchor"></a>
            <h5><a href="#word_leet">word_leet</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.word_leet</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Which word number will have its word <code>733t</code> transformed.
Useful to ensure the word will at least have a one numeric value.
Defaults to 0</p>
</td>
              </tr>
            </table>
          </section>
          <section id="word_separators">
            <a name="//apple_ref/cpp/Variable/word_separators" class="dashAnchor"></a>
            <h5><a href="#word_separators">word_separators</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.word_separators</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>String of separators to use between words.
If multiple characters one will be chosen by random.
Used by xkcd. Default is " _-,$"</p>
</td>
              </tr>
            </table>
          </section>
          <section id="word_uppercase">
            <a name="//apple_ref/cpp/Variable/word_uppercase" class="dashAnchor"></a>
            <h5><a href="#word_uppercase">word_uppercase</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator.word_uppercase</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Number of words to uppercase the first letter.
Used by xkcd. Default is 1.</p>
</td>
              </tr>
            </table>
          </section>
        <h4 class="documentation-section">Methods</h4>
          <section id="bindHotkeys">
            <a name="//apple_ref/cpp/Method/bindHotkeys" class="dashAnchor"></a>
            <h5><a href="#bindHotkeys">bindHotkeys</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator:bindHotkeys(mapping)</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Binds hotkeys for PasswordGenerator</p>
<p>Parameters:</p>
<ul>
<li>mapping - A table containing hotkey objifier/key details for the following items:<ul>
<li>copy - Generate password and copy to clipboard</li>
<li>paste - Generate password and paste</li>
</ul>
</li>
</ul>
</td>
              </tr>
            </table>
          </section>
          <section id="copyPassword">
            <a name="//apple_ref/cpp/Method/copyPassword" class="dashAnchor"></a>
            <h5><a href="#copyPassword">copyPassword</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator:copyPassword()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Generates a password and copies to clipboard</p>
<p>Parameters:</p>
<ul>
<li><p>None</p>
<p>Returns:</p>
<ul>
<li>The generated password</li>
</ul>
</li>
</ul>
</td>
              </tr>
            </table>
          </section>
          <section id="pastePassword">
            <a name="//apple_ref/cpp/Method/pastePassword" class="dashAnchor"></a>
            <h5><a href="#pastePassword">pastePassword</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>PasswordGenerator:pastePassword()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Generates a password and types it</p>
<p>Parameters:</p>
<ul>
<li><p>None</p>
<p>Returns:</p>
<ul>
<li>The generated password</li>
</ul>
</li>
</ul>
</td>
              </tr>
            </table>
          </section>
  </body>
</html>